Skip to main content
POST
/
v1
/
customers
/
{id}
/
usage
/
{aggregator_id}
/
timeseries
Get customer usage timeseries
curl --request POST \
  --url https://api.hyperline.co/v1/customers/{id}/usage/{aggregator_id}/timeseries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "start_date": "2026-01-01T00:00:00Z",
  "end_date": "2026-02-01T00:00:00Z",
  "aggregator_filter_id": "<string>",
  "group_by": "month"
}
'
{
  "timeseries": [
    {
      "tick": "<string>",
      "count": 123
    }
  ],
  "total": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.hyperline.co/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required
​
aggregator_id
string
required

Body

application/json
​
start_date
string<date-time>
required

ISO-8601 date string.

Example:

"2026-01-01T00:00:00Z"

​
end_date
string<date-time>
required

ISO-8601 date string.

Example:

"2026-02-01T00:00:00Z"

​
aggregator_filter_id
string

Optional aggregator filter ID. When set, restricts the result to events matching that filter's config. Must belong to the aggregator in the path.

​
group_by
enum<string>
default:month

Bucket size for the timeseries.

Available options:
month,
day,
hour

Response

​
timeseries
object[]
required
​
total
number
required